home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr47 / wasm223.zip / ED.DOC < prev    next >
Text File  |  1993-05-04  |  17KB  |  408 lines
  1.  
  2.  
  3.  
  4.                                       Mr Ed
  5.                                   A Text Editor
  6.  
  7.                                        by
  8.  
  9.                                    Eric Tauck
  10.                                1304 Deerpass Road
  11.                              Marengo, IL 60152-9644
  12.                                      U.S.A.
  13.  
  14.                              Compuserve: 72457,1557
  15.                        Internet: 72457.1557@compuserve.com
  16.  
  17.         Mr Ed is a simple DOS based text editor for IBM PC/XT/AT compati-
  18.         bles.  Mr Ed requires PC/MS DOS 3.0 or higher and at least 224K
  19.         of free memory.
  20.  
  21.         Mr Ed may be used and distributed freely.  The most recent ver-
  22.         sion of Mr Ed is available on 5.25" or 3.5" disk by sending $10
  23.         to the address above.  The Borland C++ source code is available
  24.         for $50.  The source code is for personal use and may not be
  25.         distributed.
  26.  
  27.         Mr Ed can only edit files that fit entirely in memory, have
  28.         18,000 lines or less, and no lines longer than 4096 characters.
  29.         Mr Ed has a fixed memory overhead of about 230,000 bytes -- all
  30.         additional free (conventional) memory is used for editing.  Mr Ed
  31.         is run by entering:
  32.  
  33.           ED [switches] [file]
  34.  
  35.         'switches' are optional command line arguments that change the
  36.         appearance or operation of Mr Ed.  'file' is the name of the file
  37.         to edit.  If a file is not specified, Mr Ed will start editing an
  38.         empty unnamed file.  Large files are loaded in the background, so
  39.         you may begin editing a large file while the rest of it is being
  40.         loaded.
  41.  
  42.                                      Display
  43.                                      -------
  44.  
  45.         The Mr Ed display consists of a status line at the top of the
  46.         screen with the rest of the screen devoted to the text being
  47.         edited.  The status line shows the file name and a file changed
  48.         marker, several state indicators, the memory free, and the cur-
  49.         rent row and column position.  The file changed marker (the
  50.         leftmost character on the status line) is a triangle if the file
  51.         doesn't exist (i.e. a new file), a block if an existing file has
  52.         been loaded, or an asterisk if the file (new or existing) has
  53.         been changed.  The state indicators show the state of the numlock
  54.         (a '#' if locked), capslock (an up-arrow if locked), the block
  55.         status ('Mrk' if marking a block or 'Blk' if a block is marked),
  56.         and the insert state ('Ins' if in insert mode).  The memory free
  57.         is thousands of bytes if a 'K' follows the number, or a simple
  58.         byte count if a 'b' follows the number.  The first number of the
  59.  
  60.  
  61.  
  62.         current location is the row and the second number is the column.
  63.  
  64.                                   Entering Text
  65.                                   -------------
  66.  
  67.         Simply type in the characters you wish to add to the file.  Text
  68.         is changed or entered at the cursor location.  If insert mode is
  69.         on (an 'Ins' is displayed on the status line), existing text will
  70.         not be overwritten by new text.  The CTRL-P command allows you to
  71.         enter keystrokes that would normally be interpreted as commands
  72.         (like ^D or TAB).  The following is a list of text entry com-
  73.         mands:
  74.  
  75.           ENTER        start a new line (splits current line)
  76.           CTRL-ENTER   insert a new line after the current line
  77.           INS          toggle the insert state
  78.  
  79.           CTRL-P       enter a literal character
  80.  
  81.                                   Deleting Text
  82.                                   -------------
  83.  
  84.         There are several commands for deleting text.  You may also
  85.         delete sections of text using the block commands described later.
  86.         The following is a list of delete commands:
  87.  
  88.           DEL          delete the character under the cursor
  89.           BKSP         delete the character to left of the cursor
  90.           CTRL-BKSP    delete the word to left of the cursor
  91.  
  92.           CTRL-B       delete to the beginning of the line
  93.           CTRL-E       delete to the end of the line
  94.           CTRL-N       delete the next word
  95.           CTRL-L       delete the entire line
  96.  
  97.                                  Cursor Movement
  98.                                  ---------------
  99.  
  100.         Most operations are performed at the cursor location.  The cursor
  101.         starts at the beginning of the file and moves as different opera-
  102.         tions are carried out.  The cursor can also be moved using any of
  103.         the commands below:
  104.  
  105.           UP           move the cursor up one line
  106.           DOWN         move the cursor down one line
  107.           LEFT         move the cursor left one column
  108.           RIGHT        move the cursor right one column
  109.           PGUP         move the cursor up one screen
  110.           PGDN         move the cursor down one screen
  111.           HOME         move the cursor to the first column
  112.           END          move the cursor to the end of the line
  113.  
  114.           CTRL-LEFT    move the cursor to the previous word
  115.           CTRL-RIGHT   move the cursor to the next word
  116.           CTRL-PGUP    scroll the file one line up
  117.  
  118.  
  119.  
  120.           CTRL-PGDN    scroll the file one line down
  121.           CTRL-HOME    move the cursor to the beginning of the file
  122.           CTRL-END     move the cursor to the end of the file
  123.  
  124.           TAB          move the cursor to the next tab stop
  125.           SHIFT-TAB    move the cursor to the previous tab stop
  126.  
  127.           ALT-G        move the cursor to a specific line number
  128.  
  129.                                Search and Replace
  130.                                ------------------
  131.  
  132.         Arbitrary sequences of characters are called strings.  Strings
  133.         can be searched for and replaced with other strings.  String
  134.         searching in Mr Ed is "case-sensitive," meaning that upper and
  135.         lower case characters must match exactly.  The following is a
  136.         list of search and replace commands:
  137.  
  138.           F2           find a string
  139.           F3           find the next occurrence of a string
  140.           F4           find and replace a string
  141.  
  142.                                      Blocks
  143.                                      ------
  144.  
  145.         Blocks are marked sections of text that can be manipulated as a
  146.         single unit.  Blocks come in two types: marked columns within a
  147.         single line (a column block), or marked rows (a line block).
  148.         Generally, block operations consist of moving the cursor to where
  149.         you want the block to start, begin marking the block, move the
  150.         cursor to where you want the block to end, stop marking the
  151.         block, and perform a block delete or write operation; OR move the
  152.         cursor again and perform a move or copy operation.  The following
  153.         is a list of block commands:
  154.  
  155.           F5           start/stop/clear marking (line block)
  156.           CTRL-F5      start/stop/clear marking (column block)
  157.  
  158.           CTRL-C       copy a block to the cursor location
  159.           CTRL-D       delete a block
  160.           CTRL-R       read a block (i.e. file) to the cursor location
  161.           CTRL-V       move a block to the cursor location
  162.           CTRL-W       write a block to a file
  163.  
  164.                                     Clipboard
  165.                                     ---------
  166.  
  167.         The clipboard is a hidden area for storing text and is useful as
  168.         an alternative method of manipulating blocks.  For instance,
  169.         instead of marking and moving a block, you can cut a block to the
  170.         clipboard and paste it in at the new location.  A clipboard
  171.         'copy' operation copies the current block to the clipboard, a
  172.         'cut' operation copies the current block to the clipboard and
  173.         then deletes the block, and a 'paste' operation inserts the
  174.         contents of the clipboard to the cursor location.  The clipboard
  175.  
  176.  
  177.  
  178.         is a fixed size of about 1/10th of the total free memory.  The
  179.         following is a list of clipboard commands:
  180.  
  181.           F6           copy a block to the clipboard
  182.           F7           cut a block to the clipboard
  183.           F8           paste the clipboard contents
  184.  
  185.                                      General
  186.                                      -------
  187.  
  188.         The following is a list of general/miscellaneous commands:
  189.  
  190.           F1           display a brief help screen
  191.  
  192.           ALT-A        display a chart of ASCII codes
  193.           ALT-H        display a brief help screen (same as F1)
  194.           ALT-L        load a new file
  195.           ALT-N        start editing a new (unnamed) file
  196.           ALT-R        rename the current file
  197.           ALT-S        save the current file
  198.  
  199.           ESC          clear block (if block marked)
  200.  
  201.           ESC          quit Mr Ed (if no block marked)
  202.           ALT-X        quit Mr Ed
  203.  
  204.                                   Configuration
  205.                                   -------------
  206.  
  207.         You can save the current configuration or dynamically change and
  208.         save the current colors from inside Mr Ed.  The following is a
  209.         list of commands for saving the configuration and changing the
  210.         colors:
  211.  
  212.           ALT-F1       save the current configuration (except colors)
  213.           ALT-F2       configure and save the colors
  214.  
  215.                                     Switches
  216.                                     --------
  217.  
  218.         There are several command line switches that allow you to config-
  219.         ure Mr Ed to your personal tastes.  These switches may be speci-
  220.         fied when Mr Ed is run, listed once and saved with the /SAVE
  221.         switch, or specified with the environment variable MRED.  When
  222.         switch settings are saved with the /SAVE switch (or the ALT-F1
  223.         command from within Mr Ed), the settings are saved permanently to
  224.         the ED.EXE file.  To use the environment variable MRED, just list
  225.         the switches as you would on the command line, for instance:
  226.  
  227.           MRED=/AUTO+ /BAK-
  228.  
  229.         Environment variables are usually set in the AUTOEXEC.BAT file.
  230.         For conflicting switch settings (for instance you specify /BEEP+
  231.         in the environment variable but /BEEP- on the command line),
  232.         environment settings take precedence over saved switch settings,
  233.  
  234.  
  235.  
  236.         and command line switches take precedence over environment set-
  237.         tings.  For switches with a '+' and '-' form, the '+' form ena-
  238.         bles the feature and the '-' form disables the feature.  The
  239.         following is a list of command line switches:
  240.  
  241.         /AUTO+
  242.         /AUTO-
  243.  
  244.           Automatically save the file when you exit via ALT-X.  Mr Ed
  245.           usually asks if you want to save any changes to your file when
  246.           you exit.  If /AUTO+ is used, Mr Ed will automatically save any
  247.           changes when you exit.  The default is /AUTO-.
  248.  
  249.         /BAK+
  250.         /BAK-
  251.  
  252.           Create backup (.BAK) files.  If backup files are enabled, Mr Ed
  253.           will save an original (i.e. unmodified) copy of the file you're
  254.           editing with a .BAK extension.  This option is a safety feature
  255.           that allows you to get your original file back.  The default is
  256.           /BAK+.
  257.  
  258.         /BEEP+
  259.         /BEEP-
  260.  
  261.           Beep on error.  These options enable an audible beep for cer-
  262.           tain Mr Ed warnings and errors.  The default is /BEEP+.
  263.  
  264.         /BW
  265.         /MONO
  266.  
  267.           Force monochrome color set.  These two switches force Mr Ed to
  268.           use only normal (white on black) or reverse (black on white)
  269.           color schemes, regardless of what custom colors have been set.
  270.           These switches are particularly useful if you have saved a
  271.           color scheme to ED.EXE that is illegible on a particular com-
  272.           puter/video system.
  273.  
  274.         /COLOR1=n
  275.  
  276.           Set the status line color.  'n' is a color value in the range 0
  277.           to 255.  The foreground color values are 0 = black, 1 = blue, 2
  278.           = green, 3 = cyan, 4 = red, 5 = magenta, 6 = brown, and 7 =
  279.           white.  The background color values are 0 = black, 16 = blue,
  280.           32 = green, 48 = cyan, 64 = red, 80 = magenta, 96 = brown, and
  281.           112 = white.  Add a foreground and background color together to
  282.           get a combined color value.  Add 8 to the total to make the
  283.           foreground brighter, and/or add 128 to make the foreground
  284.           color blink.  The Mr Ed colors can be set with command line
  285.           switches or with the ALT-F2 command from within Mr Ed.
  286.  
  287.  
  288.  
  289.         /COLOR2=n
  290.  
  291.           Set the normal text color.  See the description of the
  292.           /COLOR1=n switch.
  293.  
  294.         /COLOR3=n
  295.  
  296.           Set the block marking text color.  See the description of the
  297.           /COLOR1=n switch.
  298.  
  299.         /COLOR4=n
  300.  
  301.           Set the block marked text color.  See the description of the
  302.           /COLOR1=n switch.
  303.  
  304.         /COLOR5=n
  305.  
  306.           Set the help screen color.  See the description of the
  307.           /COLOR1=n switch.
  308.  
  309.         /COLOR6=n
  310.  
  311.           Set the end of file marker color.  See the description of the
  312.           /COLOR1=n switch.
  313.  
  314.         /DELAY=n
  315.  
  316.           Set the keyboard repeat delay rate.  This switch changes the
  317.           time that a key must held down before keystrokes start repeat-
  318.           ing.  This switch only works on extended AT style keyboards.
  319.           'n' is the number of 1/100th seconds before keys start repeat-
  320.           ing (use 0 for no change).  The default is /DELAY=0.
  321.  
  322.         /END+
  323.         /END-
  324.  
  325.           Display the end of file marker.  These switches enable or
  326.           disable a visible end of file marker when editing a file.  The
  327.           marker shows up as a line of characters across the screen.  You
  328.           can set the character used in the marker with the /END=n
  329.           switch.  The default is /END-.
  330.  
  331.         /END=n
  332.  
  333.           Set the end of file marker character.  This switch lets you set
  334.           the character used to display the end of the file marker.  'n'
  335.           is the ASCII value of the character to use.  The default is
  336.           /END=250.  The end of file marker is only displayed if the end
  337.           of file marker is enabled (see the /END+,/END- switch descrip-
  338.           tion).
  339.  
  340.  
  341.  
  342.         /EOF+
  343.         /EOF-
  344.  
  345.           Write EOF character to the end of files.  When this feature is
  346.           enabled, Mr Ed appends an EOF character (ASCII code 26) to the
  347.           end of a file when it is saved.  The default is /EOF+.
  348.  
  349.         /INSERT+
  350.         /INSERT-
  351.  
  352.           Set the insert mode.  These switches set the initial insert
  353.           state.  The default is /INSERT+.
  354.  
  355.         /LINES+
  356.         /LINES-
  357.  
  358.           Remove trailing blank lines.  When this feature is enabled, Mr
  359.           Ed removes blank lines at the end of a file when it is saved.
  360.           The default is /LINES-.
  361.  
  362.         /LOCK+
  363.         /LOCK-
  364.  
  365.           Lock options.  When this feature is enabled, Mr Ed does not
  366.           allow any configuration items to be saved to ED.EXE, either by
  367.           the /SAVE switch, or by the ALT-F1 or ALT-F2 commands.  The
  368.           default is /LOCK-.
  369.  
  370.         /RATE=n
  371.  
  372.           Set the keyboard repeat rate.  This switch sets the rate at
  373.           which keystrokes are repeated when a key is held down.  This
  374.           switch only works on extended AT style keyboards.  'n' is the
  375.           number of keys per second (use 0 for no change).  The default
  376.           is /RATE=0.
  377.  
  378.         /SAVE
  379.  
  380.           Save switch settings to ED.EXE.  This switch permanently saves
  381.           all other switch settings, so the switches need not be speci-
  382.           fied the next time Mr Ed is run.
  383.  
  384.         /SPACES+
  385.         /SPACES-
  386.  
  387.           Remove trailing spaces.  When this feature is enabled, Mr Ed
  388.           removes spaces at the end of lines when a file is saved.  The
  389.           default is /SPACES-.
  390.  
  391.                              DISCLAIMER OF WARRANTY
  392.                              ----------------------
  393.  
  394.         THIS SOFTWARE AND MANUAL ARE DISTRIBUTED "AS IS" AND WITHOUT
  395.         WARRANTIES AS TO PERFORMANCE OF MERCHANTABILITY OR ANY OTHER
  396.         WARRANTIES WHETHER EXPRESSED OR IMPLIED.  BECAUSE OF THE VARIOUS
  397.  
  398.  
  399.  
  400.         HARDWARE AND SOFTWARE ENVIRONMENTS INTO WHICH THIS PROGRAM MAY BE
  401.         PUT, NO WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE IS OFFERED.
  402.  
  403.         GOOD DATA PROCESSING PROCEDURE DICTATES THAT ANY PROGRAM BE
  404.         THOROUGHLY TESTED WITH NON-CRITICAL DATA BEFORE RELYING ON IT.
  405.         THE USER MUST ASSUME THE ENTIRE RISK OF USING THE PROGRAM.  ANY
  406.         LIABILITY OF THE SELLER WILL BE LIMITED EXCLUSIVELY TO PRODUCT
  407.         REPLACEMENT OR REFUND OF PURCHASE PRICE.
  408.